Skip to main content

Rename-IMAlbum

SYNOPSIS​

Renames Immich albums

SYNTAX​

Rename-IMAlbum [[-Session] <ImmichSession>] [-Id] <String[]> [-NewName] <String>
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION​

Changes the name of one or more Immich albums. This is a convenient wrapper around Set-IMAlbum specifically for renaming operations.

EXAMPLES​

EXAMPLE 1​

Rename-IMAlbum -Id 'album-uuid' -NewName 'Family Vacation 2024'

Renames the specified album.

EXAMPLE 2​

Get-IMAlbum -SearchString 'temp*' | Rename-IMAlbum -NewName 'Archived Photos'

Renames all albums with names starting with 'temp' to 'Archived Photos'.

EXAMPLE 3​

Rename-IMAlbum -Id 'album-uuid' -NewName 'Wedding Photos' -Confirm:$false

Renames the album without confirmation prompt.

PARAMETERS​

-Session​

Optionally define an Immich session object to use. This is useful when you are connected to more than one Immich instance.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id​

The UUID(s) of the album(s) to rename. Accepts pipeline input and multiple values.

Type: String[]
Parameter Sets: (All)
Aliases: ids, albumId

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-NewName​

The new name for the album(s).

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf​

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm​

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

This cmdlet supports ShouldProcess and will prompt for confirmation before renaming albums.

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github